<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="games_v1.html">Google Play Games Services API</a> . <a href="games_v1.scores.html">scores</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.</p>
<p class="toc_element">
  <code><a href="#get_next">get_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#list">list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the scores in a leaderboard, starting from the top.</p>
<p class="toc_element">
  <code><a href="#listWindow">listWindow(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, resultsAbove=None, returnTopIfAbsent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the scores in a leaderboard around (and including) a player's score.</p>
<p class="toc_element">
  <code><a href="#listWindow_next">listWindow_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#submit">submit(leaderboardId, score, language=None, scoreTag=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits a score to the specified leaderboard.</p>
<p class="toc_element">
  <code><a href="#submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits multiple scores to leaderboards.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
  <pre>Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for &#x27;ALL&#x27; leaderboards and &#x27;ALL&#x27; timeSpans in the same request; only one parameter may be set to &#x27;ALL&#x27;.

Args:
  playerId: string, A player ID. A value of `me` may be used in place of the authenticated player&#x27;s ID. (required)
  leaderboardId: string, The ID of the leaderboard. Can be set to &#x27;ALL&#x27; to retrieve data for all leaderboards for this application. (required)
  timeSpan: string, The time span for the scores and ranks you&#x27;re requesting. (required)
    Allowed values
      ALL - Get the high scores for all time spans. If this is used, maxResults values will be ignored.
      ALL_TIME - Get the all time high score.
      WEEKLY - List the top scores for the current day.
      DAILY - List the top scores for the current week.
  includeRankType: string, The types of ranks to return. If the parameter is omitted, no ranks will be returned.
    Allowed values
      ALL - Retrieve all supported ranks. In HTTP, this parameter value can also be specified as `ALL`.
      PUBLIC - Retrieve public ranks, if the player is sharing their gameplay activity publicly.
      SOCIAL - (Obsolete) Retrieve the social rank.
      FRIENDS - Retrieve the rank on the friends collection.
  language: string, The preferred language to use for strings returned by this method.
  maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
  pageToken: string, The token returned by the previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of player leaderboard scores.
  &quot;items&quot;: [ # The leaderboard scores.
    { # A player leaderboard score object.
      &quot;friendsRank&quot;: { # A score rank in a leaderboard. # The rank of the score in the friends collection for this leaderboard.
        &quot;formattedNumScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard as a string.
        &quot;formattedRank&quot;: &quot;A String&quot;, # The rank in the leaderboard as a string.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
        &quot;numScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard.
        &quot;rank&quot;: &quot;A String&quot;, # The rank in the leaderboard.
      },
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`.
      &quot;leaderboard_id&quot;: &quot;A String&quot;, # The ID of the leaderboard this score is in.
      &quot;publicRank&quot;: { # A score rank in a leaderboard. # The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.
        &quot;formattedNumScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard as a string.
        &quot;formattedRank&quot;: &quot;A String&quot;, # The rank in the leaderboard as a string.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
        &quot;numScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard.
        &quot;rank&quot;: &quot;A String&quot;, # The rank in the leaderboard.
      },
      &quot;scoreString&quot;: &quot;A String&quot;, # The formatted value of this score.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;scoreValue&quot;: &quot;A String&quot;, # The numerical value of this score.
      &quot;socialRank&quot;: { # A score rank in a leaderboard. # The social rank of the score in this leaderboard.
        &quot;formattedNumScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard as a string.
        &quot;formattedRank&quot;: &quot;A String&quot;, # The rank in the leaderboard as a string.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
        &quot;numScores&quot;: &quot;A String&quot;, # The number of scores in the leaderboard.
        &quot;rank&quot;: &quot;A String&quot;, # The rank in the leaderboard.
      },
      &quot;timeSpan&quot;: &quot;A String&quot;, # The time span of this score.
      &quot;writeTimestamp&quot;: &quot;A String&quot;, # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScoreListResponse`.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
  &quot;player&quot;: { # A Player resource. # The Player resources for the owner of this score.
    &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
    &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
    &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
    &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
    &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
      &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
      &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
        &quot;level&quot;: 42, # The level for the user.
        &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
        &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
      },
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
      &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
      &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
        &quot;level&quot;: 42, # The level for the user.
        &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
        &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
      },
    },
    &quot;friendStatus&quot;: &quot;A String&quot;, # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
    &quot;gamePlayerId&quot;: &quot;A String&quot;, # Per-application unique player identifier.
    &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
    &quot;name&quot;: { # A representation of the individual components of the name.
      &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
      &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
    },
    &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
    &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
    &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
      &quot;friendsListVisibility&quot;: &quot;A String&quot;,
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
      &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
    },
    &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get_next">get_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="list">list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the scores in a leaderboard, starting from the top.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
  collection: string, The collection of scores you&#x27;re requesting. (required)
    Allowed values
      PUBLIC - List all scores in the public leaderboard.
      SOCIAL - (Obsolete) Legacy G+ social scores.
      FRIENDS - List only scores of friends.
  timeSpan: string, Required. The time span for the scores and ranks you&#x27;re requesting. (required)
    Allowed values
      ALL_TIME - The score is an all-time score.
      WEEKLY - The score is a weekly score.
      DAILY - The score is a daily score.
  language: string, The preferred language to use for strings returned by this method.
  maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
  pageToken: string, The token returned by the previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ListScores response.
  &quot;items&quot;: [ # The scores in the leaderboard.
    { # The Leaderboard Entry resource.
      &quot;formattedScore&quot;: &quot;A String&quot;, # The localized string for the numerical value of this score.
      &quot;formattedScoreRank&quot;: &quot;A String&quot;, # The localized string for the rank of this score for this leaderboard.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
      &quot;player&quot;: { # A Player resource. # The player who holds this score.
        &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
        &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
        &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
        &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
        &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
          &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
          &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
            &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
            &quot;level&quot;: 42, # The level for the user.
            &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
            &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
          },
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
          &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
          &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
            &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
            &quot;level&quot;: 42, # The level for the user.
            &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
            &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
          },
        },
        &quot;friendStatus&quot;: &quot;A String&quot;, # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
        &quot;gamePlayerId&quot;: &quot;A String&quot;, # Per-application unique player identifier.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
        &quot;name&quot;: { # A representation of the individual components of the name.
          &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
          &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
        },
        &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
        &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
        &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
          &quot;friendsListVisibility&quot;: &quot;A String&quot;,
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
          &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
        },
        &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
      },
      &quot;scoreRank&quot;: &quot;A String&quot;, # The rank of this score for this leaderboard.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;scoreValue&quot;: &quot;A String&quot;, # The numerical value of this score.
      &quot;timeSpan&quot;: &quot;A String&quot;, # The time span of this high score.
      &quot;writeTimestampMillis&quot;: &quot;A String&quot;, # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
  &quot;numScores&quot;: &quot;A String&quot;, # The total number of scores in the leaderboard.
  &quot;playerScore&quot;: { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player&#x27;s score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the `scoreRank`and `formattedScoreRank` values will not be present.
    &quot;formattedScore&quot;: &quot;A String&quot;, # The localized string for the numerical value of this score.
    &quot;formattedScoreRank&quot;: &quot;A String&quot;, # The localized string for the rank of this score for this leaderboard.
    &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
    &quot;player&quot;: { # A Player resource. # The player who holds this score.
      &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
      &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
      &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
      &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
      &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
        &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
        &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          &quot;level&quot;: 42, # The level for the user.
          &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
          &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
        },
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
        &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
        &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          &quot;level&quot;: 42, # The level for the user.
          &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
          &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
        },
      },
      &quot;friendStatus&quot;: &quot;A String&quot;, # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
      &quot;gamePlayerId&quot;: &quot;A String&quot;, # Per-application unique player identifier.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
      &quot;name&quot;: { # A representation of the individual components of the name.
        &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
        &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
      },
      &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
      &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
      &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
        &quot;friendsListVisibility&quot;: &quot;A String&quot;,
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
        &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
      },
      &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
    },
    &quot;scoreRank&quot;: &quot;A String&quot;, # The rank of this score for this leaderboard.
    &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
    &quot;scoreValue&quot;: &quot;A String&quot;, # The numerical value of this score.
    &quot;timeSpan&quot;: &quot;A String&quot;, # The time span of this high score.
    &quot;writeTimestampMillis&quot;: &quot;A String&quot;, # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
  },
  &quot;prevPageToken&quot;: &quot;A String&quot;, # The pagination token for the previous page of results.
}</pre>
</div>

<div class="method">
    <code class="details" id="listWindow">listWindow(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, resultsAbove=None, returnTopIfAbsent=None, x__xgafv=None)</code>
  <pre>Lists the scores in a leaderboard around (and including) a player&#x27;s score.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
  collection: string, The collection of scores you&#x27;re requesting. (required)
    Allowed values
      PUBLIC - List all scores in the public leaderboard.
      SOCIAL - (Obsolete) Legacy G+ social scores.
      FRIENDS - List only scores of friends.
  timeSpan: string, Required. The time span for the scores and ranks you&#x27;re requesting. (required)
    Allowed values
      ALL_TIME - The score is an all-time score.
      WEEKLY - The score is a weekly score.
      DAILY - The score is a daily score.
  language: string, The preferred language to use for strings returned by this method.
  maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
  pageToken: string, The token returned by the previous request.
  resultsAbove: integer, The preferred number of scores to return above the player&#x27;s score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
  returnTopIfAbsent: boolean, True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ListScores response.
  &quot;items&quot;: [ # The scores in the leaderboard.
    { # The Leaderboard Entry resource.
      &quot;formattedScore&quot;: &quot;A String&quot;, # The localized string for the numerical value of this score.
      &quot;formattedScoreRank&quot;: &quot;A String&quot;, # The localized string for the rank of this score for this leaderboard.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
      &quot;player&quot;: { # A Player resource. # The player who holds this score.
        &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
        &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
        &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
        &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
        &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
          &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
          &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
            &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
            &quot;level&quot;: 42, # The level for the user.
            &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
            &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
          },
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
          &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
          &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
            &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
            &quot;level&quot;: 42, # The level for the user.
            &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
            &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
          },
        },
        &quot;friendStatus&quot;: &quot;A String&quot;, # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
        &quot;gamePlayerId&quot;: &quot;A String&quot;, # Per-application unique player identifier.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
        &quot;name&quot;: { # A representation of the individual components of the name.
          &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
          &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
        },
        &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
        &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
        &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
          &quot;friendsListVisibility&quot;: &quot;A String&quot;,
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
          &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
        },
        &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
      },
      &quot;scoreRank&quot;: &quot;A String&quot;, # The rank of this score for this leaderboard.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;scoreValue&quot;: &quot;A String&quot;, # The numerical value of this score.
      &quot;timeSpan&quot;: &quot;A String&quot;, # The time span of this high score.
      &quot;writeTimestampMillis&quot;: &quot;A String&quot;, # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
  &quot;numScores&quot;: &quot;A String&quot;, # The total number of scores in the leaderboard.
  &quot;playerScore&quot;: { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player&#x27;s score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the `scoreRank`and `formattedScoreRank` values will not be present.
    &quot;formattedScore&quot;: &quot;A String&quot;, # The localized string for the numerical value of this score.
    &quot;formattedScoreRank&quot;: &quot;A String&quot;, # The localized string for the rank of this score for this leaderboard.
    &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
    &quot;player&quot;: { # A Player resource. # The player who holds this score.
      &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
      &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
      &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
      &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
      &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
        &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
        &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          &quot;level&quot;: 42, # The level for the user.
          &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
          &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
        },
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
        &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
        &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          &quot;level&quot;: 42, # The level for the user.
          &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
          &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
        },
      },
      &quot;friendStatus&quot;: &quot;A String&quot;, # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
      &quot;gamePlayerId&quot;: &quot;A String&quot;, # Per-application unique player identifier.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
      &quot;name&quot;: { # A representation of the individual components of the name.
        &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
        &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
      },
      &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
      &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
      &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
        &quot;friendsListVisibility&quot;: &quot;A String&quot;,
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
        &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
      },
      &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
    },
    &quot;scoreRank&quot;: &quot;A String&quot;, # The rank of this score for this leaderboard.
    &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
    &quot;scoreValue&quot;: &quot;A String&quot;, # The numerical value of this score.
    &quot;timeSpan&quot;: &quot;A String&quot;, # The time span of this high score.
    &quot;writeTimestampMillis&quot;: &quot;A String&quot;, # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
  },
  &quot;prevPageToken&quot;: &quot;A String&quot;, # The pagination token for the previous page of results.
}</pre>
</div>

<div class="method">
    <code class="details" id="listWindow_next">listWindow_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="submit">submit(leaderboardId, score, language=None, scoreTag=None, x__xgafv=None)</code>
  <pre>Submits a score to the specified leaderboard.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
  score: string, Required. The score you&#x27;re submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units. (required)
  language: string, The preferred language to use for strings returned by this method.
  scoreTag: string, Additional information about the score you&#x27;re submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of leaderboard entry resources.
  &quot;beatenScoreTimeSpans&quot;: [ # The time spans where the submitted score is better than the existing score for that time span.
    &quot;A String&quot;,
  ],
  &quot;formattedScore&quot;: &quot;A String&quot;, # The formatted value of the submitted score.
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.
  &quot;leaderboardId&quot;: &quot;A String&quot;, # The leaderboard ID that this score was submitted to.
  &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
  &quot;unbeatenScores&quot;: [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player&#x27;s `DAILY` score, but not better than the player&#x27;s scores for the `WEEKLY` or `ALL_TIME` time spans.
    { # A player score.
      &quot;formattedScore&quot;: &quot;A String&quot;, # The formatted score for this player score.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.
      &quot;score&quot;: &quot;A String&quot;, # The numerical value for this player score.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;timeSpan&quot;: &quot;A String&quot;, # The time span for this player score.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</code>
  <pre>Submits multiple scores to leaderboards.

Args:
  body: object, The request body.
    The object takes the form of:

{ # A list of score submission requests.
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreSubmissionList`.
  &quot;scores&quot;: [ # The score submissions.
    { # A request to submit a score to leaderboards.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#scoreSubmission`.
      &quot;leaderboardId&quot;: &quot;A String&quot;, # The leaderboard this score is being submitted to.
      &quot;score&quot;: &quot;A String&quot;, # The new score being submitted.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;signature&quot;: &quot;A String&quot;, # Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986.
    },
  ],
}

  language: string, The preferred language to use for strings returned by this method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of score submission statuses.
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreListResponse`.
  &quot;submittedScores&quot;: [ # The score submissions statuses.
    { # A list of leaderboard entry resources.
      &quot;beatenScoreTimeSpans&quot;: [ # The time spans where the submitted score is better than the existing score for that time span.
        &quot;A String&quot;,
      ],
      &quot;formattedScore&quot;: &quot;A String&quot;, # The formatted value of the submitted score.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.
      &quot;leaderboardId&quot;: &quot;A String&quot;, # The leaderboard ID that this score was submitted to.
      &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      &quot;unbeatenScores&quot;: [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player&#x27;s `DAILY` score, but not better than the player&#x27;s scores for the `WEEKLY` or `ALL_TIME` time spans.
        { # A player score.
          &quot;formattedScore&quot;: &quot;A String&quot;, # The formatted score for this player score.
          &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.
          &quot;score&quot;: &quot;A String&quot;, # The numerical value for this player score.
          &quot;scoreTag&quot;: &quot;A String&quot;, # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
          &quot;timeSpan&quot;: &quot;A String&quot;, # The time span for this player score.
        },
      ],
    },
  ],
}</pre>
</div>

</body></html>